Update the README with current information
authorAlex Crichton <alex@alexcrichton.com>
Wed, 30 Jul 2014 17:11:36 +0000 (10:11 -0700)
committerAlex Crichton <alex@alexcrichton.com>
Wed, 30 Jul 2014 17:11:36 +0000 (10:11 -0700)
Closes #271
Closes #274
Closes #292

README.md

index d7b63978d5f0acfa584116f8339c26108c8c5d49..ba5b0ba60988711d2fa3c1cfbd47a8f0e4ac9cb8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,24 +9,42 @@ to compile on rust master as it may lag behind by a day or two. Nightlies,
 however, will run regardless of this fact!
 
 ```
-$ curl -O http://static.rust-lang.org/cargo-dist/cargo-nightly-linux.tar.gz
-$ tar xf cargo-nightly-linux.tar.gz
-$ ./cargo-nightly/install.sh
+$ triple=x86_64-unknown-linux-gnu
+$ curl -O http://static.rust-lang.org/cargo-dist/cargo-nightly-$triple.tar.gz
+$ tar xf cargo-nightly-$triple.tar.gz
+$ ./cargo-nightly-$triple/install.sh
 ```
 
-The current nightlies available are:
+Nightlies are available for the following triples:
 
-* [`cargo-nightly-linux`](http://static.rust-lang.org/cargo-dist/cargo-nightly-linux.tar.gz)
-* [`cargo-nightly-win`](http://static.rust-lang.org/cargo-dist/cargo-nightly-win.tar.gz)
-* [`cargo-nightly-mac`](http://static.rust-lang.org/cargo-dist/cargo-nightly-mac.tar.gz)
+* [`x86_64-unknown-linux-gnu`](http://static.rust-lang.org/cargo-dist/cargo-nightly-x86_64-unknown-linux-gnu.tar.gz)
+* [`i686-unknown-linux-gnu`](http://static.rust-lang.org/cargo-dist/cargo-nightly-i686-unknown-linux-gnu.tar.gz)
+* [`x86_64-apple-darwin`](http://static.rust-lang.org/cargo-dist/cargo-nightly-x86_64-apple-darwin.tar.gz)
+* [`i686-apple-darwin`](http://static.rust-lang.org/cargo-dist/cargo-nightly-i686-apple-darwin.tar.gz)
+* [`i686-pc-mingw32`](http://static.rust-lang.org/cargo-dist/cargo-nightly-i686-pc-mingw32.tar.gz)
+
+Note that if you're using the windows snapshot you will need Mingw-w64 installed
+as well as MSYS. The installation script needs to be run inside the MSYS shell.
 
 ## Compiling cargo
 
-Run `./configure` to create a Makefile.  (`./configure --help` will show common
-options.)
+Cargo can be compiled like many other standard unix-like projects:
+
+```
+$ git clone https://github.com/rust-lang/cargo
+$ cd cargo
+$ ./configure
+$ make
+$ make install
+```
 
-Then it's as simple as ```make``` followed by ```make install``` and you're
-ready to go.
+More options can be discovered through `./configure`, such as compiling cargo
+for more than one target. For example, if you'd like to compile both 32 and 64
+bit versions of cargo on unix you would use:
+
+```
+$ ./configure --target i686-unknown-linux-gnu,x86_64-unknown-linux-gnu
+```
 
 ## Contributing to the Docs
 
@@ -35,6 +53,14 @@ All you need to do is change the markdown files in the source directory.
 
 [1]: https://github.com/wycats/cargo-website
 
+## Reporting Issues
+
+Found a bug? We'd love to know about it!
+
+Please report all issues on the github [issue tracker][issues].
+
+[issues]: https://github.com/rust-lang/cargo/issues
+
 ## License
 
 Cargo is primarily distributed under the terms of both the MIT license